API breaking changes for Pre-built Automations
The following Admin Essentials APIs have introduced breaking changes for the 2021.2 release:
- POST /prebuilts/import
- DELETE /prebuilts/:id
⚠ Note: Refer to Itential Breaking Changes for more documentation on the breaking changes introduced.
Default log_filename for new services
Previously, all new services created within IAP would be instantiated with a loggerProps.log_filename value of pronghorn.log. As of the 2021.2 release, these services will instead use the service_config name to generate a more specific default filename. For example, an adapter created with the name adapter1 will now start with a default log_filename of adapter1.log. This only affects new services, and will not affect existing loggerProps configurations.
Health Module APIs
The following APIs have been deprecated and will be removed in the 2021.2 release.
Note: Refer to the Itential API Guide for documentation on the replacement
/healthAPIs listed below.
| Item | Description | Replacement |
|---|---|---|
| GET /health/modules | Get the health data of all current services in IAP. | GET /health/adapters or GET /health/applications |
| GET /health/module/:module | Get the health data for a single service in IAP. | GET /health/adapters/:name or GET /health/applications/:name |
User Management Feature Deprecated
The user-management feature has been deprecated in the 2021.2 release and is scheduled to be removed in the next two release cycles.
For local_aaa adapter use, the replacement is to use your prefered mongo user interface to add, modify, and delete users in MongoDB.
⚠ Note: Refer to Product Notices for more information listing the APIs that will be deprecated.
New Job Details Permission
Viewing the Job Details pages now requires a new permission getJobDetails (defined within WorkflowEngine) that may not be enabled in some customers' custom roles. If you have custom roles and want those roles to access the Job Details page, then ensure they have access to either the WorkFlowEngine apiread role or the getJobDetails method. Hint: To do this, find the custom role in Authorization, search for getJobDetails in the WorkFlowEngine application, and add it to the role.